Organizing API Endpoints

When organizing API endpoints, they should be based on the resources instead of on actions. The request methods will determine what action should be taken at a given URL endpoint. Your entire API's scheme should be consistent, clear and concise. Below are the principles and examples from the video, for your reference:

Principles

• Should be intuitive
• Organize by resource
  • Use nouns in the path, not verbs
  • The method used will determine the operation taken
  • GOOD:
    • https://example.com/posts
  • BAD:
    • https://example.com/get_posts
• Keep a consistent scheme
  • Plural nouns for collections
  • Use parameters to specify a specific item
  • GOOD:
    • https://example.com/entrees
    • https://example.com/entrees/5
  • BAD:
    • https://example.com/entree
    • https://example.com/entree_five
• Don’t make them too complex or lengthy
  • No longer than collection/item/collection
  • GOOD:
    • https://example.com/entrees/5/reviews
  • BAD:
    • https://example.com/entrees/5/customers/4/reviews

Methods & Endpoints Review

The request method used will determine the operation performed for the given resource URI. Though your API documentation should explain exactly what operation is performed and data returned via the response, it should be intuitive for anyone using your API, such as in the example below.

QUIZ QUESTION: :

The following API endpoints are poorly formatted. Match each endpoint with the principle of API endpoints that it violates.

ANSWER CHOICES: